/*
 * This file Copyright (c) 2015. Walle.
 * (http://www.wallellen.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the
 * Walle Agreement (WA) and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or WA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Walle Agreement (WA), this file
 * and the accompanying materials are made available under the
 * terms of the WA which accompanies this distribution, and
 * is available at http://www.wallellen.com/agreement.html
 *
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 */

package com.wallellen.lucene.server;


import com.wallellen.lucene.adapter.DocMap;

/**
 * 基于lucene的全文检索,索引引擎
 *
 * @author <a href="mailto:wallellen@hotmail.com">WALLE</a>
 */
public interface DocIndexInter {
    /**
     * 做索引到内存中
     *
     * @param doc         要写入的文档
     * @param newIndexDir 新建立索引的文件夹，将来会合并到原有索引文件中
     */
    public void indexDoc(DocMap doc) throws Exception;

    /**
     * 关闭索引生成器 ，同時合并内存索引到文件索引中
     */
    public void close() throws Exception;

    /**
     * 从物理索引文件中删除索引
     *
     * @param docId 索引ID字段
     * @throws Exception
     */
    public void deleteFhysicsIndex(String docId) throws Exception;

    /**
     * 从内存索引文件中删除索引
     *
     * @param docId 索引ID字段
     * @throws Exception
     */
    public void deleteRamIndex(String docId) throws Exception;
}
